<html lang="en" xml:lang="en"><head>
<META http-equiv="Content-Type" content="text/html">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"><META name="description" content="The Analysis widget provides an easy way to use spatial analysis tools."><meta name="content-language" content="en"><link href="rsrc/htmlhelp.css" rel="stylesheet" type="text/css"><title>Web AppBuilder for ArcGIS | Help - 
Analysis widget
</title>
                <script type="text/javascript" language="JavaScript">
                    var pathL  = self.location.pathname.split ("/");
                    var fname = pathL[pathL.length-1];
                    var i = fname.lastIndexOf (".htm");
                    if (i>=0) {
                    fname = fname.substring (0, i)
                    } else {
                    //??
                    }
                    if (self.location.hash) {
				    		      fname = fname + self.location.hash;
						        }
                    self.location.replace ("../index.html#//" + fname);
                </script>
                </head><!--Publication GUID: [GUID-E7D1C130-8F87-4109-8D61-E73A46083F52]--><!--Topic GUID: [GUID-2F8C4E09-265B-40D4-8DA7-B0B158405903]--><body><div id="content"><div class="header"><h1>
Analysis widget
</h1><div id="breadcrumb"></div></div>
    <p id="GUID-336C4C92-63B6-4591-B1F6-AE200E68F630">The Analysis widget provides an easy way to use ArcGIS Online or Portal for ArcGIS spatial analysis tools in your application. With 22   analysis tools, the same as those in the ArcGIS Online map viewer, you can  configure  one  tool per widget or multiple tools in a widget. See the <a class="xref" target="_blank" rel="http://server.arcgis.com/en/portal/latest/use/perform-analysis.htm" href="http://server.arcgis.com/en/portal/latest/use/perform-analysis.htm">Perform analysis</a> section of the ArcGIS Online help for an introduction to spatial analysis, the license requirements to access analysis tools, and details about the usage of each tool. If you're a developer, you can access these tools via web APIs. For more information, see <a target="_blank" class="xref" href="https://developers.arcgis.com/rest/analysis/" rel="https://developers.arcgis.com/rest/analysis/">Spatial analysis service REST API</a>. </p>
    
    <p id="GUID-6BA0D9DC-C089-4A02-9E39-903124EFDA68" ishcondition="agol_plat in (wab_dev,web)">Using a spatial analysis service consumes credits. For more information on credits, see <a target="_blank" class="xref" href="http://www.esri.com/software/arcgis/arcgisonline/credits" rel="http://www.esri.com/software/arcgis/arcgisonline/credits">Service credits overview</a>.</p>
    
    
    <p id="GUID-9B5E299B-3028-41EA-8434-26FFE4A30150">Analysis tools must have access to the data used by the layers and services on which you run them. If you use ArcGIS Server map or feature services, the analysis tools must have access to the data; therefore, the URL to the service must be a public URL or be on the same network as your portal.</p>
    <div class="section1" id="GUID-A8211E84-9410-426E-9778-C9F743209D78" purpose="section1"><h2>
Configuring the Analysis widget
</h2></div>
    <div class="wfsteps" purpose="wfsteps"><h4></h4><div class="steps" id="GUID-707E7BD4-BDDA-4743-83AF-04D194CF5EAA"><div class="step_title">Steps:</div><ol>
        <li purpose="step" id="GUID-5C180BDE-5B38-4222-8B0E-0D306D4B9F6D">
          <span purpose="cmd" id="GUID-CC8479A1-364F-40EE-A9B3-0BB11053B966">
Hover over the Analysis widget and click the small edit icon <img purpose="img" placement="inline" alt="Edit icon" title="Edit icon" src="03w3/GUID-31D329BD-BC73-4BBE-AE1D-3A1261BF912A-web.png">.  
The configuration window for this widget opens.</span>
        </li>
        <li purpose="step" id="ESRI_STEP_D9A28B49EE5644D28A45F0BAB789092C">
          <span purpose="cmd" id="GUID-C2466752-3CF6-43A6-94C1-A1E1299D8314">Twenty-three  tools are listed alphabetically in the configuration window.  Choose the  tools you want to include in the widget.<div class="image" purpose="image"><table><tr><td><img class="break" src="03w3/GUID-68BFCA79-7737-4BA7-88FF-0066C510F104-web.png" purpose="img" alt="Analysis configuration window" title="Analysis configuration window"></td></tr></table></div></span>
        </li>
        <li purpose="step" id="ESRI_STEP_00A1265D419D4D568CE8D891E82EC3BE">
          <span purpose="cmd" id="GUID-E5F87EA4-28C7-428A-922F-A53E44EA1AF1">Click the settings icon next to your selected tool. The following options are available:</span>
          <ul purpose="choices" id="ESRI_CHOICES_67A02CEA43E246148C27AFB47A237393">
            <li purpose="choice" id="ESRI_CHOICE_DFA45EE8C7E94FABB4954AA17CC54FB8">
              <span class="uicontrol">The tool display name</span>—Provide your tool name.</li>
            <li purpose="choice" id="ESRI_CHOICE_6CE613E0766B46BBA2EF62E361BAF7B5">
              <span class="uicontrol">Show help links in the widget</span>—Controls whether to show help links in the widget.</li>
            <li purpose="choice" id="ESRI_CHOICE_2493BBF2D1DB457382B5045D04D4101B">
              <span class="uicontrol">Show option to use the current map extent</span>—Controls whether to show the option to use the current map extent.</li>
            <li purpose="choice" id="ESRI_CHOICE_A2025C86C99748E19CFEE950D7F1DD77" ishcondition="agol_plat in (wab_dev,web)">
              <span class="uicontrol">Display Show credits option</span>—Controls whether to show the credits link.</li>
            <li purpose="choice" id="ESRI_CHOICE_CC7C8EB6DE484F5FB4DEE9F70C1B7F59">
              <span class="uicontrol">Save the result in user's account</span>—Controls whether to allow users to save the result  in their accounts.</li>
            <li purpose="choice" id="ESRI_CHOICE_7998F264C3A04D1CA20BAFAA3D7C277D" ishcondition="agol_plat in (wab_dev,web)">
              <span class="uicontrol">Show ready to use layers from ArcGIS Online living atlas of the world</span>—Controls whether to show ready to use layers from ArcGIS Online Living Atlas of the World.</li><li purpose="choice" id="ESRI_CHOICE_CD5253C1A5B149F88B0DFBF7A9BA13F5"><span class="uicontrol">Allow to export results</span>---Controls whether to allow users to export the result to CSV, Feature Collection or GeoJSON formats.</li>
          </ul>
        </li>
        <li purpose="step" id="ESRI_STEP_4380341B6A424943AF87C00CE14E5608">
          <span purpose="cmd" id="GUID-BC1A3D4A-0EAA-4DA1-B773-49294A71BC35">Repeat step 3 if you have more than one selected tool.</span>
        </li>
        <li purpose="step" id="ESRI_STEP_9E964B9515A8430FB3D0FD07115BAAE0">
          <span purpose="cmd" id="GUID-D333C374-73E4-4987-BB8F-A222D8AE59D5">Click  <span class="uicontrol">OK</span> to save the configuration and close the window.</span>
        </li>
      </ol></div></div>
    <div class="section1" id="ESRI_SECTION1_2CD20F7EAADC47C49C13D39B610FD9D8" purpose="section1"><h2>Using the Analysis widget</h2><p id="GUID-E22AFC2F-17B9-41A7-83BA-977E3F748149">To perform analysis, the administrator of your organization needs to grant you certain privileges. To use any of the analysis tools, you need the following privileges: <ul purpose="ul" id="UL_99A43BADBE7D411A8C87307BF334955B"><li purpose="li" id="LI_06CC79DBDB3D4314B71BC047302EAEE5">Create, update, and delete content</li><li purpose="li" id="LI_8355A427D5E54D2D9C545D0B95FF5A02">Publish hosted features</li><li purpose="li" id="LI_31F2567E2A044D89835D9787E6E28439">Spatial analysis</li></ul></p><p id="GUID-33B1D64E-95B1-411F-99E8-2B2955DEFEB5">Certain tools need additional privileges such as network analysis and GeoEnrichment. See  <a class="xref" target="_blank" rel="http://server.arcgis.com/en/portal/latest/use/perform-analysis.htm" href="http://server.arcgis.com/en/portal/latest/use/perform-analysis.htm">Perform analysis</a> for more information. If you don't have required privileges, the corresponding tools will not be available  in the widget panel.</p></div>
    <div class="wfsteps" purpose="wfsteps"><h4></h4><div class="steps" id="ESRI_STEPS_A1A27B84A91B43408EA1F688AE0BDC44"><div class="step_title">Steps:</div><ol>
        <li purpose="step" id="ESRI_STEP_A2961E6D115F4F3CBF20DDF77E768882">
          <span purpose="cmd" id="GUID-6FA69EF8-698C-437E-BC6B-567081E4E925">Verify that you are signed in to your organization with <a class="xref" target="_blank" rel="http://server.arcgis.com/en/portal/latest/administer/windows/roles.htm" href="http://server.arcgis.com/en/portal/latest/administer/windows/roles.htm">privileges</a> to perform analysis. </span>
        </li>
        <li purpose="step" id="ESRI_STEP_A6123736914540E0A4644814017529A5">
          <span purpose="cmd" id="GUID-69ECF647-100B-4D25-8A34-DD58D1C8C8F9">Click the widget icon in your app to open the widget panel. If more than one tool is configured,  choose  tools one at a time   to execute. If only one tool is available, it activates automatically. Click the help icon <img purpose="img" placement="inline" alt="Analysis help icon" title="Analysis help icon" src="03w3/GUID-A60CCC9F-06B1-41EF-9E11-D6079A3356BF-web.png"> for  information about the tool.  </span>
        </li>
        <div class="stepinfo" purpose="stepinfo">
          <div class="notes" id="GUID-AC00BA37-5D4B-4615-BE76-82579FB99BCB"><div class="note"><img class="note_img" src="rsrc/note.png" alt="Note" title="Note"><span>Note:</span></div><div class="tipbody">
            <p id="GUID-63800186-319C-4E30-A813-ED715EAD2B15">If you don't have required  privileges to run a tool, the tool  will not display in the widget panel.  In addition to privileges, each tool has its own requirement for the layer or layers. If a tool does not have a required layer or layers in the map, the tool will be unavailable. </p>
            <p id="GUID-CB9A93AB-B682-41FC-A7E3-06B64AB9DFA3">Also note that the  Extract Data tool requires the extract capability be set in the service.</p>
          </div></div>
        </div>
        <li purpose="step" id="ESRI_STEP_3CAFDF87DD4847698905B071883B97AB">
          <span purpose="cmd" id="GUID-611181F6-2BF2-4177-B42A-97836565C9C1"> Choose an input layer from the drop-down list,  configure the parameters for the tool, and click  <span class="uicontrol">Run Analysis</span>.</span>
        </li>
        <div class="stepinfo" purpose="stepinfo"><div class="notes" id="GUID-AC276C7C-BD1E-4B4F-B80E-73A721E1D2EE"><div class="tip"><img class="note_img" src="rsrc/tip.png" alt="Tip" title="Tip"><span>Tip:</span></div><div class="tipbody"><p id="GUID-B545D33B-6D9B-422F-98E3-2E63B646BE5C">For more information about the configuration dialog box, see the <a class="xref" target="_blank" rel="http://server.arcgis.com/en/portal/latest/use/use-analysis-tools.htm" href="http://server.arcgis.com/en/portal/latest/use/use-analysis-tools.htm">Work with a tool dialog box</a> section of the ArcGIS Online help or  <a class="xref" target="_blank" rel="http://server.arcgis.com/en/portal/latest/use/use-analysis-tools.htm" href="http://server.arcgis.com/en/portal/latest/use/use-analysis-tools.htm">Use Analysis tools</a> in the Portal for ArcGIS help .</p></div></div>
          </div>
        <li purpose="step" id="ESRI_STEP_8683A07097D04B5188FC62E6FAE9712D">
          <span purpose="cmd" id="GUID-921AD772-EB3C-4CE7-A4D6-355CF6101D27">When the tool is running, the execution messages display in the panel. Click the cancel icon if you want to cancel  the job.</span>
          <div class="info" purpose="info">
            <p id="GUID-F38F24CF-2590-4568-9285-C5BB7EE22DB8">A   job for a tool consuming credits cannot be cancelled.</p>
          </div>
          <div class="stepresult" purpose="stepresult">
            <p id="GUID-D58A3575-A317-4074-B3E7-E9E47182CE27">When the job is successful, the result is saved  to My Content.  Click the  item link under Outputs  to view the item details in   your portal. In addition, the results as a feature layer or layers or a table or tables are automatically added to   the map as operational layers.<div class="image" purpose="image"><table><tr><td><img class="break" src="03w3/GUID-BD910B9D-D420-472D-B531-594B828D7F6D-web.png" purpose="img" alt="Outputs" title="Outputs"></td></tr></table></div>If the job is not successful, an error message displays in red. Click <span class="uicontrol">Back</span> to return to the parameters' configuration. Additionally, you may see the output name with an   export button if you choose the option to export the files.</p>
          </div>
        </li>
        <li purpose="step" id="ESRI_STEP_8D61AD64C5D944489A6F212D80A2FE55">
          <span purpose="cmd" id="GUID-0E9A1829-5B95-4040-ACA6-A64F8343ED67">If you have more than one tool, click <span class="uicontrol">Home</span> to choose other tools.</span>
        </li>
      </ol></div></div>
  <div class="footer"> Copyright © 1995-2016 Esri. All rights reserved. </div></div></body></html>